/*
 * Copyright 2000-2016 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.intellij.troubleshooting;

import com.intellij.openapi.extensions.ExtensionPointName;
import com.intellij.openapi.project.Project;
import com.intellij.troubleshooting.ui.CollectTroubleshootingInformationDialog;
import org.jetbrains.annotations.NotNull;

/**
 * Implement this interface and register the implementation as com.intellij.troubleInfoCollector extension
 * to see result of {@link #collectInfo} in "Help|Collect Troubleshooting Information" dialog.
 * <p>
 * Implement toString() for better presentation in {@link CollectTroubleshootingInformationDialog}
 */
public interface TroubleInfoCollector {
  ExtensionPointName<TroubleInfoCollector> EP_SETTINGS = ExtensionPointName.create("com.intellij.troubleInfoCollector");

  @NotNull
  String collectInfo(@NotNull Project project);
}
